GetProcessInstanceSummary (Deprecated) |
The GetProcessInstanceSummary SOAP method is used to retrieve the summary of a process instance. This method is a part of the the Method Set Query Process Instance Data 4.2 interface with the namespace http://schemas.cordys.com/pim/queryinstancedata/1.0.
SOAP Request
<SOAP:Envelope xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP:Body> <GetProcessInstanceSummary xmlns="http://schemas.cordys.com/pim/queryinstancedata/1.0"> <Query xmlns="http://schemas.cordys.com/cql/1.0"> <Select> <QueryableObject>InstancesSummary</QueryableObject> <Field>ProcessName</Field> <Field>ProcessFolder</Field> <Field>ShortProcessName</Field> <Field>Version</Field> <Field>ModelSpace</Field> <Field>NrTotal</Field> <Field>NrRunning</Field> <Field>NrQueued</Field> <Field>NrWaiting</Field> <Field>NrTerminated</Field> <Field>NrSkipped</Field> <Field>NrReplaced</Field> <Field>NrComplete</Field> <Field>NrAborted</Field> <Field>NrSuspended</Field> <Field>NrDebug</Field> <Field>NrDebugReady</Field> </Select> <Filters/> <GroupBy/> <OrderBy/> </Query> </GetProcessInstanceSummary> </SOAP:Body> </SOAP:Envelope>
Request Parameters
Parameter |
Description |
Mandatory |
Accepted Input Values |
---|---|---|---|
QueryableObject |
Name of the database object that is to be queried |
Yes |
Fully qualified name of the object |
Field |
Name of the database column, whose details are to be queried |
No |
Any column name of the database object |
Filters |
Constraints to filter the response |
No |
And, Or, EQ, NQ, LT, LE, GT, GE, In, Like, Between, IsNull, Not (may be nested and repeated) |
GroupBy |
Fields on which the results must be grouped |
No |
One or more of the Property elements |
OrderBy |
Fields on which the results must be ordered |
No |
One or more of the Property elements. The ordering sequence depends upon the sequence of the Property elements. |
SOAP Response
<data> <GetProcessInstanceSummaryResponse xmlns="http://schemas.cordys.com/pim/queryinstancedata/1.0" xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/"> <data> <tuple> <old> <Summary> <ProcessName>10 processes</ProcessName> <ProcessFolder/> <ShortProcessName>10 processes</ShortProcessName> <PublishedTo>0</PublishedTo> <Description/> <NrTotal>101</NrTotal> <NrRunning>0</NrRunning> <NrWaiting>0</NrWaiting> <NrTerminated>0</NrTerminated> <NrComplete>101</NrComplete> <NrAborted>0</NrAborted> <NrSuspended>0</NrSuspended> <NrDebug>0</NrDebug> <NrDebugReady>0</NrDebugReady> </Summary> </old> </tuple> </data> </GetProcessInstanceSummaryResponse> </data>
Response Parameters
Parameter |
Description |
---|---|
ProcessName |
Fully qualified name of the busines process |
ProcessFolder |
Folder structure of the business process |
ShortProcessName |
The name part of the fully qualified business process name |
PublishedTo |
Space where the business process is deployed 0: organization, 1: isv |
Description |
Description of the business process |
NrTotal |
Total number of instances |
NrRunning |
Number of running instances |
NrWaiting |
Number of waiting instances |
NrTerminated |
Number of terminated instances |
NrComplete |
Number of completed instances |
NrAborted |
Number of aborted instances |
NrSuspended |
Number of suspended instances |
NrDebug |
Number of debugged instances |
NrDebugReady |
Number of instances ready for debug |